package com.danciyixue.boot.dcyx.service;

import com.danciyixue.boot.dcyx.model.entity.UserStudyWordHistory;
import com.danciyixue.boot.dcyx.model.form.UserStudyWordHistoryForm;
import com.danciyixue.boot.dcyx.model.query.UserStudyWordHistoryQuery;
import com.danciyixue.boot.dcyx.model.vo.TodayStudyWordReportVO;
import com.danciyixue.boot.dcyx.model.vo.UserStudyWordHistoryVO;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * 历史单词学习记录服务类
 *
 * @author youlaitech
 * @since 2025-06-15 16:20
 */
public interface UserStudyWordHistoryService extends IService<UserStudyWordHistory> {

    /**
     *历史单词学习记录分页列表
     *
     * @return {@link IPage<UserStudyWordHistoryVO>} 历史单词学习记录分页列表
     */
    IPage<UserStudyWordHistoryVO> getUserStudyWordHistoryPage(UserStudyWordHistoryQuery queryParams);

    /**
     * 获取历史单词学习记录表单数据
     *
     * @param id 历史单词学习记录ID
     * @return 历史单词学习记录表单数据
     */
     UserStudyWordHistoryForm getUserStudyWordHistoryFormData(Long id);

    /**
     * 新增历史单词学习记录
     *
     * @param formData 历史单词学习记录表单对象
     * @return 是否新增成功
     */
    boolean saveUserStudyWordHistory(UserStudyWordHistoryForm formData);

    /**
     * 修改历史单词学习记录
     *
     * @param id   历史单词学习记录ID
     * @param formData 历史单词学习记录表单对象
     * @return 是否修改成功
     */
    boolean updateUserStudyWordHistory(Long id, UserStudyWordHistoryForm formData);

    /**
     * 删除历史单词学习记录
     *
     * @param ids 历史单词学习记录ID，多个以英文逗号(,)分割
     * @return 是否删除成功
     */
    boolean deleteUserStudyWordHistorys(String ids);

    /**
     * 获取用户今日单词学习报告
     *
     * @return 用户今日单词学习报告
     */
    TodayStudyWordReportVO getTodayStudyWordReport();
}
